Actions
Actions are assigned to fields, and they provide a means of mapping profile data to target services. Some examples of actions are:
-
Move to Trip Record
-
Move to Air Shop
-
Move to Activity Panel
-
Move to Create Air Reservation Request
Each action is triggered by an event that applies the action in order to map data from the profile to a target. Agencies indirectly define how to map profile data to target services by assigning one or more actions and endpoints to template fields. Data within those fields is governed by the associated action/endpoint.
Actions have the following required attributes which are assigned by the system:
-
Unique ID
-
Name
-
Description
-
Consuming system - defines which system is the target of the action and its data.
-
Target Service - the name of the service to which profile data is being sent.
-
Details of each service endpoint associated to the action.
-
A given action can have 0 endpoints.
-
Each service endpoint is associated with one and only one action. The unique ID is used to differentiate among endpoints (for example, between a Car.Origin endpoint used in a CarShop action versus a Car.Origin endpoint used in a TripRecord action).
Target Service
A target service could be any function that takes profile data as input in order to perform a function. Some examples of target services are:
-
Pages or portions of the Universal Desktop, such as the air or hotel shopping pages
-
The activity panel, or the booking page
-
A web service of the Universal API
Endpoints
A service endpoint is the input parameter of the Target Service. In other words, it is the page or service field/element into which data is inserted when an action is applied. For example, the Trip Record action could have endpoints of:
-
FOP/Credit Card.Number
-
FOP/CC.Type
-
FOP.CC.ExpDate
-
Name.First
-
Name.Middle
-
Name.Last
When endpoint data is defined, ensure that the naming conventions clearly define multiple endpoints in the same service that might be similar (e.g., two PostalCodes).
Service endpoints have the following required attributes assigned by the system:
-
Unique ID
-
Name
-
Description
Service endpoints have the following required attributes assigned by the user:
-
Minimum and Maximum occurrences - Define how many pieces of data can be sent to the endpoint.
-
Data type - Used in validation to ensure the template field data type and the endpoint data type are compatible. If an action is assigned to a template field where the endpoint data type is incompatible with the field data type, the API returns a warning. The following data types are supported for action endpoints:
-
String
-
Float
-
Date
-
DateTime
-
Money
-
Boolean
-
Integer
Guidelines
-
Actions and endpoints are assigned to profile data indirectly, via template fields.
-
Actions are applied to template fields. This includes both fixed fields and custom fields. Actions are not applied to template field groups (fixed or custom).
-
A given template field can be assigned from zero (0) to many actions.
-
If a template field is assigned an action, then it must be assigned a minimum of one (1) or more endpoints per action. Each template field can have 1 or multiple endpoints per each action defined for it.
-
Any user authorized to manage a given template is authorized to manage the action/endpoint assignments on it (no separate authorization is needed).
-
A user must be authorized to retrieve an action and/or its endpoints.
-
Each template could have more than one field with the same action-endpoint.
-
System templates have the default action(s)/endpoint(s) that Travelport has assigned to each template field.
-
Agencies, when modifying default templates, can add or remove actions and endpoints from fields (fixed or custom).
-
The data types between a template field and an endpoint must be compatible; otherwise, a warning displays.